home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfwhotrv.zip / SFWHOTRV.DOC < prev    next >
Text File  |  1990-06-02  |  16KB  |  365 lines

  1.                                  
  2.                                     SFWHOTRV 
  3.                                   Version 1.0
  4.                             by JOHN & MARY BUTLER of
  5.                                 TWILIGHT Software
  6.  
  7.     
  8.    INTRODUCTION
  9.    ------------
  10.                          
  11.       SFWHOTRV is a fast paced trivia game designed to run as a door feature
  12.    within the SPITFIRE Bulletin Board System Version 2.9. Which makes this  
  13.    file share compatable.  A data file containing 300 trivia questions is 
  14.    randomly accessed and displayed to the screen.  With each question that 
  15.    is displayed, four multiple choice options are provided from which the 
  16.    player may select their answer.  SFWHOTRV allows the player ten seconds 
  17.    to read the question and respond with the number corresponding to the 
  18.    answer they believe is correct.
  19.       
  20.     
  21.    SFWHOTRV SETUP
  22.    --------------
  23.     
  24.       To set up SFWHOTRV to be executed as a door, it is recommended that
  25.    a separate directory be set up for it.  For explanation purposes, let's
  26.    assume the directory DOOR1 is created for use with SFWHOTRV.  The following
  27.    files must then be placed in the directory:
  28.    
  29.    SFWHOTRV.EXE    The actual game program.
  30.    
  31.    SFWHOTRV.DAT    The data file containing the trivia questions.
  32.    
  33.    SFWHOTRV.TOP    This is a listing of the top ten players.  SFWHOTRV.EXE
  34.                    will create this file if it is not found. 
  35.    
  36.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  37.    as illustrated below:
  38.    
  39.    :DOOR_1
  40.    COPY SFDOORS.DAT C:\SF\DOOR1
  41.    SFWHOTRV
  42.    ERASE SFDOORS.DAT
  43.    GOTO LOOP
  44.      
  45.    You will notice that the commands needed to execute SFWHOTRV are placed
  46.    between the :DOOR_1 and GOTO LOOP command lines.  These are entered in
  47.    place of the existing REM Place Program Name Here.  The following will 
  48.    briefly explain each of the commands which were set up within SF.BAT to 
  49.    run SFWHOTRV as a SPITFIRE Door program:
  50.    
  51.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  52.    door.  It contains information about the user such as name and password.
  53.    SFWHOTRV requires access to the information within SFDOORS.DAT.  Therefore,
  54.    before executing the program it must be copied to the directory in which
  55.    SFWHOTRV is running.
  56.    
  57.       SFWHOTRV is the program name and executes the game program from within
  58.    the door program.
  59.    
  60.       Once the user has terminated the game play of SFWHOTRV the SF.BAT file
  61.    erases the SFDOORS.DAT file.
  62.  
  63.  
  64.    
  65.    
  66.    SFWHOTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  67.    --------------------------------------------- 
  68.  
  69.       SPITFIRE has a sysop configurable command for the Main, Message and
  70.    File menus.  The sysop configurable command is executed through a
  71.    batch file which corresponds to the menu it is being run from.  In
  72.    other words, SFMAIN.BAT runs the sysop configurable command from
  73.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  74.    SFFILE.BAT the one from the File Menu.  The commands necessary
  75.    to execute SFWHOTRV can be set up in the batch file which corresponds
  76.    to the menu you wish to have SFWHOTRV run from.
  77.  
  78.       The first thing you will need to establish is which of these menus
  79.    you wish to use to run SFWHOTRV.  For this purpose, let's assume that
  80.    it is going to be set up so it can be run from the Main Menu.  (It
  81.    should be noted the set up procedure is the same regardless of which
  82.    Menu you are running SFWHOTRV from.).
  83.  
  84.       Next, you will need to decide what you wish to name the command
  85.    option and establish what security level will be required for
  86.    users of your system to be able to access this option.  Once this
  87.    is determined you will need to modify the SFMAIN.MNU file using
  88.    your favorite text editor, as long as it saves in ASCII format.
  89.    (Refer to the SPITFIRE manual for further documentation on this
  90.    if needed.  It should also be noted that if SFWHOTRV were being
  91.    set up to run from the File Menu, you would need to modify the
  92.    SFFILE.MNU file and if it was being set up to be run from the
  93.    Message Menu you would need to modify the SFMSG.MNU file.)
  94.  
  95.  
  96.       Examining the default SFMAIN.MNU file, you will notice the sysop
  97.    configurable command appears as:
  98.  
  99.         <K>............. Add Your Own,,1000,@
  100.  
  101.  
  102.       This will need to be replaced with a Command Character that will
  103.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  104.    that the Command Character must not duplicate an existing Command
  105.    Character for another menu option.  You will then need to include
  106.    a brief description of the Wildcat door program you are running, two
  107.    commas, the security level required to access this feature, and another
  108.    comma followed by the a @.  The @ must not be changed! (For more detailed
  109.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  110.    to your SPITFIRE manual.)
  111.     
  112.        <K>.... Brief Program Description,,10,@
  113.  
  114.  
  115.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  116.    so that it can be executed from the Main Menu.  Do this using your
  117.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  118.    should be noted that if SFWHOTRV were being set up to run from the File
  119.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  120.    set up to be run from the Message Menu you would need to modify the
  121.    SFMESS.BAT file.)
  122.  
  123.       Place the SFWHOTRV.EXE file in the directory you wish to run the
  124.    program from.  SFWHOTRV will create its own player score file,
  125.    SFWHOTRV.TOP, if does not already exist.
  126.  
  127.       The commands set up in the SFMAIN.BAT file are very similar to
  128.    those used for executing the game through a door in the SF.BAT file.
  129.    For instance, if you were running SFWHOTRV from the main SPITFIRE
  130.    directory your SFMAIN.BAT file might look like this:
  131.  
  132.        ECHO OFF
  133.        BRK OFF
  134.        SFWHOTRV
  135.        BRK ON
  136.  
  137.       (BRK is not included in the SPITFIRE package because it is written
  138.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  139.    our board TWILIGHT BBS (515)-284-1418, The Mother Board BBS and Buffalo 
  140.    Creek's BBS as well as a number of other BBS systems.  BRK is not 
  141.    required to run SFWHOTRV, however, it is recommended since it will 
  142.    prevent a user using the CTRL BRK command to terminate the batch file, 
  143.    gaining access to your system at the DOS level.)
  144.  
  145.       If you wish to set SFWHOTRV up in a separate subdirectory from
  146.    SPITFIRE, for instance, a subdirectory named SFWHOTRV, your batch
  147.    file might look like this.
  148.  
  149.        ECHO OFF
  150.        BRK OFF
  151.        COPY SFMAIN.DAT \SF\SFWHOTRV
  152.        CD \SF\SFWHOTRV
  153.        SFWHOTRV
  154.        ERASE SFMAIN.DAT
  155.        CD \SF
  156.        BRK ON
  157.  
  158.  
  159.       When SFWHOTRV is executed, from either the door with the SF.BAT file
  160.    or from the sysop configurable command through a menu with the
  161.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  162.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  163.    SFDOORS.DAT file.  It will look for each of these files until it finds
  164.    it and the commands required for its execution.  If none of these
  165.    files are found, SFWHOTRV will halt its execution.
  166.    
  167.    
  168.  
  169.    LOCAL PLAY OF SFWHOTRV
  170.    ---------------------
  171.  
  172.       It should also be noted that a Sysop can play SFWHOTRV locally by       
  173.    entering the following command at the DOS prompt:
  174.    
  175.    C:> SFWHOTRV /L
  176.  
  177.  
  178.    DTE LOCK FEATURE
  179.    ----------------
  180.    
  181.  
  182.       SFWHOTRV automatically detects if the DTE is locked at 19200 baud.  If
  183.    SFWHOTRV detects that the DTE is locked, then SFWHOTRV opens the serial
  184.    port to the maximum baud rate of your system.  If SFWHOTRV does not 
  185.    detect that the DTE is locked, then the serial port is opened to the
  186.    baud rate of the caller.
  187.    
  188.  
  189.    SYSOP FEATURES
  190.    --------------
  191.    
  192.       With the release of Version 2.8 several enhancements were added 
  193.    which give the sysop additional control over the door game play on
  194.    the BBS system.  First, a status line is now displayed on the BBS
  195.    monitor that provides information concerning the caller's name, baud
  196.    rate of the caller and the security level of the caller.     
  197.    
  198.       A SFWHOTRV.LMT file has now been incorporated which allows the
  199.    sysop to establish a time limit for door play according to the security
  200.    level the caller has on the system.  To modify the accompanying 
  201.    SFWHOTRV.LMT file, use your favorite text editor to represent the
  202.    various security levels you have available on your system, a comma 
  203.    then the corresponding time you wish to allow for that particular
  204.    security level in minutes.  For instance, it might look like this:
  205.    
  206.    10,15
  207.    25,20
  208.    50,25
  209.    999,30
  210.    
  211.    Each security level should begin a new line and you should have a
  212.    setting for each security level you have available on your system.
  213.    If you do not have a time limit set for a particular security 
  214.    SFWHOTRV will default to the level 10 security level setting.
  215.    
  216.       Pressing the Shift Key and the F1 key simultaneously will 
  217.    terminate game play of SFWHOTRV and return the caller back to the
  218.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  219.    terminate game play of SFWHOTRV and log the caller off of the BBS.
  220.    If the Shift Key and the F9 key are pressed together, logging the
  221.    caller off the BBS, SPITFIRE will recycle and return to the
  222.    SPITFIRE Ready For Caller Prompt.   
  223.             
  224.       With SPITFIRE 2.9 a file share has been added to allow for multi-
  225.    node playing of this game.
  226.  
  227.    
  228.    SFWHOTRV EXECUTION
  229.    ------------------
  230.       
  231.    When first executed, SFWHOTRV will display a list of the Top Ten high
  232.    score players and the percentage of correct responses they acheived
  233.    while playing SFWHOTRV.  Initially, this will be a dummy listing with
  234.    ten lines that display:
  235.    
  236.       0%...............YOUR NAME COULD BE HERE
  237.       
  238.    However, as the game is played, this will fill with the name of the
  239.    players and their percentage ratings.  
  240.    
  241.    NOTE: At least twenty questions must be attempted before SFWHOTRV will
  242.          will figure the percentage rating for the player.
  243.          
  244.    To keep things interesting...the Sysop can erase the file which contains
  245.    the top ten listings SWHOTRV.TOP on a routine basis to give additional
  246.    players a chance to have their name added to the list.
  247.    
  248.    As the top ten list is displayed, at the bottom of the screen  is a
  249.    question which prompts the user whether they want to have ANSI Graphics
  250.    (y/n)? available to them during game play.  If the user responds with a
  251.    y (for yes) the game will display in color and if the user responds with
  252.    a n (for no) the game will display in monochrome.
  253.    
  254.   
  255.    PLAYING SFWHOTRV
  256.    -----------------
  257.   
  258.       Immediately after pressing any key (other than <Q> for Quit) from 
  259.    the Top Ten listing the game screen is displayed.  The screen will
  260.    look like the following:
  261.       
  262.    ------------------------------------------------------------------------
  263.    
  264.    ╔═══════════════════════════════════════════╗
  265.    ║         >>>>>>> SFWHOTRV <<<<<<<          ║
  266.    ║               Version 1.0                 ║
  267.    ║ WHO'S WHO Trivia Game For SPITFIRE Doors  ║
  268.    ║      Shareware by TWILIGHT Software       ║
  269.    ║            All Rights Reserved            ║
  270.    ║        Copyright (C) BY John Butler       ║
  271.    ║           UNREGISTERED VERSION!           ║
  272.    ╚═══════════════════════════════════════════╝   
  273.        
  274.    RIGHT: 0                        WRONG: 0
  275.     
  276.    QUESTION:
  277.    The assorted trivia questions will be displayed
  278.    here.
  279.     
  280.    <1> Choice 1                        <2> Choice 2
  281.    <3> Choice 3                        <4> Choice 4
  282.     
  283.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  284.                        
  285.    -----------------------------------------------------------------------
  286.    
  287.    The first randomly choosen trivia question is selected from the data
  288.    file and is displayed to the screen. 
  289.    
  290.       The player makes his selection by entering the corresponding number.
  291.    As the game progresses, SFWHOTRV will provide a running total of the
  292.    correct answers and also of the wrong answers the user has selected
  293.    during the game play.
  294.  
  295.    If the ten second timer should elapse before you respond, SFWHOTRV
  296.    will count this as a wrong response and add an incorrect answer to 
  297.    the total WRONG answers obtained so far.
  298.            
  299.  
  300.    EXITING PLAY
  301.    ------------
  302.    
  303.       When you are ready to exit the game, simply select press "Q" for
  304.    <Q>uit.  If you qualify as one of the top ten players to date, 
  305.    SFWHOTRV will congratulate you for becoming one of the top ten scorers
  306.    and add your name to the Top Ten listing.  You will once again see the 
  307.    Top Ten list displayed with your name added to the list.  
  308.    
  309.      If you exit the game before you have completed the twenty
  310.    questions required for eligibility to the Top Ten list or if you do not
  311.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  312.    you will be prompted to press any key to return to SPITFIRE.
  313.    
  314.    
  315.    DISTRIBUTION
  316.    ------------
  317.      
  318.       Please feel free to share SFWHO.ZIP with others.  However, it must
  319.    be distributed with SFWHOTRV.EXE, SFWHOTRV.DAT, SFWHOTRV.TOP and the
  320.    SFWHOTRV.DOC in the SFWHOTRV.ZIP distribution package.  These files must
  321.    not be altered in any way or by any means.
  322.    
  323.          SFWHOTRV.ZIP is distributed as "FREE" software.  You are free to
  324.    try SFWHOTRV, and have fun with it. We Would like to hope our program is
  325.    worth something to you so a donation of $10.00 if you like it would be
  326.    much appreciated. We are giving all the money to our children's college
  327.    fund. So help Us help them and Enjoy.
  328.  
  329.         If you feel inclined to donate you will also get special privileges
  330.    on my BBS. Send the money to the following. With name and password for
  331.   the BBS support.
  332.                  
  333.                             John Butler
  334.                            543 Haventree
  335.                         Hazelwood Mo. 63042
  336.                              
  337.    DISCLAIMER
  338.    ----------
  339.    
  340.      JOHN OR Mary BUTLER shall not be held responsible for any damage 
  341.    incurred by the user to hardware, software, or peripheral devices 
  342.    while running SFWHOTRV.  All responsibility belongs to the user of 
  343.    the software.
  344.    
  345.    
  346.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  347.    225-8496 for his assistance.  Without his help this program would not
  348.    have been possible.   
  349.    
  350.  
  351.    SFWHOTRV and other SPITFIRE programs are available for download from:
  352.    
  353.         Buffalo Creek BBS                     The Mother Board BBS
  354.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  355.           (515) 225-8496                         (515) 986-3445
  356.        19200/9600/2400/1200                      9800/2400/1200
  357.  
  358.                               TWILIGHT BBS
  359.                         Sysops -John & Mary Butler
  360.                              (515) 284-1418
  361.                          19200/9600/2400/1200/300
  362.                          
  363.  
  364.  
  365.